refactor: 💡 Bundle parameter shouldn't be a negation #34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: d709fac The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
10 tasks
gabrielmpinto
previously approved these changes
Sep 19, 2024
heldrida
added a commit
to fleek-platform/website
that referenced
this pull request
Sep 19, 2024
## Why? The bundle parameter has changed in fleek-platform/cli#34, thus the documentation has to reflect the changes.⚠️ Related to fleek-platform/cli#34 ## How? - Update guides ## Tickets? - [PLAT-1273](https://linear.app/fleekxyz/issue/PLAT-1273/the-bundle-parameter-is-not-intuitive-due-to-negation-eg-nobundle) ## Contribution checklist? - [x] The commit messages are detailed - [x] The `build` command runs locally - [ ] Assets or static content are linked and stored in the project - [ ] Document filename is named after the slug - [ ] You've reviewed spelling using a grammar checker - [ ] For documentation, guides or references, you've tested the commands and steps - [ ] You've done enough research before writing ## Security checklist? - [ ] Sensitive data has been identified and is being protected properly - [ ] Injection has been prevented (parameterized queries, no eval or system calls) - [ ] The Components are escaping output (to prevent XSS) ## References? Optionally, provide references such as links ## Preview? Optionally, provide the preview url here
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why?
Most parameters take a value. The bundle parameter is optional but shouldn't be a negation. It's confusing and counter-intuitive. Rather, have the bundle parameter that defaults to true, e.g. defaults to bundling. If the user wants to prevent bundling, it'd have to set the bundle parameter to false, which is a similar flow as for other parameters, e.g. name.
How?
Tickets?
Contribution checklist?
buildcommand runs locallySecurity checklist?
Preview?